﻿//AcademicPlanner - course registration planning web app.
//Copyright (C) 2009  Boubacar Diallo

//This program is free software; you can redistribute it and/or
//modify it under the terms of the GNU General Public License
//as published by the Free Software Foundation; either version 2
//of the License, or (at your option) any later version.

//This program is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU General Public License for more details.

//You should have received a copy of the GNU General Public License
//along with this program; if not, write to the Free Software
//Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.


using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using AcademicPlanner.Data.Entities;
using NHibernate.Tool.hbm2ddl;
using NHibernate;

namespace AcademicPlanner.Data.Repositories
{
	/// <summary>
	/// PlannerEntityRepository serves as the repository for <c>PlannerEntity</c>s.
	/// </summary>
	/// <since>1.0</since>
	public class PlannerEntityRepository : EntityRepository<PlannerEntity>
    {
		internal override string DBTableName {get { return "planners"; } }

		PlannerEntityRepository() 
		{
			namedQueriesPrefix = "PlannerEntity";
		}

		class InstanceHolder 
		{
			internal static PlannerEntityRepository INSTANCE = new PlannerEntityRepository(); 
		}


		internal static PlannerEntityRepository GetInstance()
		{ 
		    return InstanceHolder.INSTANCE; 
		}

		/// <summary>
		/// Finds from the data storage the <c>PlannerEntity</c>
		/// with a <c>UserEntity</c> having the provided username.
		/// </summary>
		/// <remarks>
		/// This methods gets the hibernate query with a name suffix of
		/// "by.userentity.name" and executes it.
		/// </remarks>
		/// <param name="pUserName">The username to look for.</param>
		/// <returns>The <c>PlannerEntity</c> or <c>null</c>.</returns>
		/// <exception cref="T:AcademicPlanner.Data.DataException">
		/// Thrown with an error code of <c>DataErrorCode.QUERY_PLANNER_ENTITY_BY_USER_ENTITY_NAME_FAILED</c>
		/// when an error is reported by NHibernate. The <c>HibernateException</c> is
		/// accessible via the <c>InnerException</c> property.
		/// </exception>
		/// <seealso cref="M:GetNamedQuery"/>
		/// <since>1.0</since>
		public PlannerEntity FindByUserName(string pUserName)
		{
			PlannerEntity rEnt = null;

			try
			{
				var vQuery = GetNamedQuery("by.userentity.name");
				vQuery.SetString("userentityName", pUserName);
				rEnt = (PlannerEntity)vQuery.UniqueResult();
			}
			catch (HibernateException vHx)
			{
				var vDx = new DataException(DataErrorCode.QUERY_PLANNER_ENTITY_BY_USER_ENTITY_NAME_FAILED, vHx);
				throw vDx;
			}

			return rEnt;
		}
    }
}
